home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 1.iso / ARGONET / ARGO / WWW / WEBKIT_4.ARC / Tutorial / WebGuide < prev   
Text File  |  1999-01-11  |  15KB  |  332 lines
  1. User web site document
  2. ~~~~~~~~~~~~~~~~~~~~~~
  3. Updated 11th June 1997
  4.  
  5. Visit the web site http://www.argonet.co.uk/WebLoad/ for information about
  6. Webload II!
  7.  
  8. For each of our users, we are allocating a TWENTY MegaBytes ("20MB") of
  9. web space. This is for whatever you want - text, images or sounds, for
  10. business or private use.
  11.  
  12. The first 20MB is free - you will not need to pay any fee for having
  13. your pages on our site, and you can make as many changes to your pages
  14. as you want without incurring any upload charges.  If in the future you
  15. find that you need more than 20MB in the future then please get in
  16. touch, but, when you consider that most of the data is compressed 20MB
  17. can hold a very, very large amount of data.
  18.  
  19. This document shows how a web page can be created on our web site. Please
  20. note that WE ARE UNABLE TO OFFER SUPPORT ON HTML DESIGN, but we will support
  21. the WebPack software, and answer any questions on the web server system.
  22.  
  23. Your home directory
  24. ~~~~~~~~~~~~~~~~~~~
  25. If, for example, your main email address is "jr.hartley@argonet.co.uk",
  26. then your web page will be "http://www.argonet.co.uk/users/jr.hartley".
  27.  
  28. If the "users" part doesn't suit your purposes - for instance, if you are
  29. using you web pages for business purposes - then you can also tell people to
  30. use the following alternatives:
  31. http://www.argonet.co.uk/homepages/jr.hartley
  32. http://www.argonet.co.uk/business/jr.hartley
  33. http://www.argonet.co.uk/education/jr.hartley
  34.  
  35. How to create web pages
  36. ~~~~~~~~~~~~~~~~~~~~~~~
  37. You will need to create HTML pages - you can do this using !Edit (or your
  38. favourite text editor), but you will need to understand HTML. HTML is a
  39. fairly simple programming language, but it can get quite complex.
  40. This document will not tell you how to create a really good web page;
  41. it will only tell you the basics. If you want more information about HTML,
  42. then it's best to read a book.
  43.  
  44. The first thing you need to learn about is tags. HTML uses tags to denote
  45. certain aspects of a piece of text. These tags are text strings, enclosed
  46. within "<" and ">". For example, "<HEAD>" would mean the header of an HTML
  47. document. These tags can be in be in capitals or in lower case. In this
  48. brief guide, they are shown as capitals, but you should keep the case the
  49. same, so if you start off with lower case, you must use lower case for all
  50. the other tags.
  51.  
  52. Since these tags are applied to blocks of text, you also need to turn off
  53. tags, such as bold. This is done in the same way, except the tag is
  54. preceeded by "/".
  55.  
  56. For example, "<B>This is some bold text</B> and this isn't" would
  57. produce just that. The tag "B" indicates that the text following it will be
  58. displayed in bold. Similarly, "I" is used for italic.
  59.  
  60. An HTML document is split into two sections - the Header and the Body. The
  61. header contains information such as the title of the page, while the body
  62. has the main text.
  63.  
  64. An example HTML page is :
  65.  
  66. <HTML>
  67. <HEAD><TITLE>My home page (mk 1)</TITLE>
  68. </HEAD>
  69. <BODY BGCOLOR="#ffffff">
  70. I am <I>very</I> clever, but
  71. don't
  72. rush me!
  73. </BODY>
  74. </HTML>
  75.  
  76. The first line tells the web browser that this is an HTML document. If you
  77. copy these lines to another file, and make sure it's file type is "HTML",
  78. then you can use Voyager's web program to view it. If you look closely, you
  79. will find that the carriage returns at the end of "but", "don't" and "me!"
  80. aren't actually displayed. HTML is known as a free-format system, where
  81. carriage returns, multiple spaces and tabs aren't used at all.
  82.  
  83. So, how do you get a carriage return? Simple. The token "BR" indicates a
  84. break in the line. It is one of the tags that doesn't have an end, so you
  85. only need to put it in where you want the web browser to split the line.
  86.  
  87. You can also do paragraph breaks with a <P> tag. Two or more <BR>s will be
  88. treated like multiple spaces - only the first will be used.
  89.  
  90. <P>A paragraph of text.
  91. <P>Another paragraph.
  92.  
  93. In this example, the <P> tag tells the browser a new paragraph has started.
  94. There are occasions when you will come across a </P> tag. You can ignore it
  95. for now.
  96.  
  97. Links (pointing to other web pages)
  98. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  99. The next thing to look at is links. Links allow you to jump from one page to
  100. another, not necessarily in the same user directory, or even site!
  101.  
  102. A link (or anchor) is denoted by the token "A". This token is more complex
  103. than the previous one, as it has some extra parameters inside the "<>"s.
  104.  
  105. An example link is :
  106.  
  107. To find some information, click <A HREF="http://www.argonet.co.uk">here</A>
  108.  
  109. The HREF indicates where the link is going to go. If you were to insert this
  110. into the HTML file, the "here" text would be coloured blue, and underlined.
  111.  
  112. You can have links to other pages inside your directory very easily. For
  113. example, the lines :
  114.  
  115. <A HREF="http://www.argonet.co.uk/users/zenith/aboutme.html">
  116.  
  117. and
  118.  
  119. <A HREF="aboutme.html">
  120.  
  121. would be the same, and would also have the advantage that you can test out
  122. your web pages before putting them on our web site, using Voyager's web
  123. browser.
  124.  
  125. These references could also be to email addresses, for example, you could
  126. use :
  127.  
  128. <A HREF="mailto:support@argonet.co.uk">ArgoNet Technical Support</A>
  129.  
  130. which would create a link on the text ArgoNet Technical Support, so that when
  131. you click on it, an e-mail window will appear.
  132.  
  133. Images
  134. ~~~~~~
  135. Images form a major factor of web pages. You can place images onto your web
  136. pages, using the token "Img". This token is used in a similar fashion to
  137. the link token, in that it takes other parameters.
  138.  
  139. An example link would be :
  140.  
  141. <IMG SRC="mypiccy.gif" ALT="A picture of me">
  142.  
  143. The SRC extra parameter is where the image is stored. The ALT parameter is
  144. some textual element which is displayed if the web browser has images turned
  145. off, or it is a text-only browser.
  146.  
  147. Note that images should be GIF format files, and CANNOT be Acorn sprites. If
  148. you have a sprite you wish to convert to GIF, use !WebGIF, !Creator,
  149. SprToGIF, all of which can be downloaded from our FTP site, inside the PD
  150. directory.
  151.  
  152. At a pinch, you could use JPEGs, but some (early) browsers do not accept
  153. JPEGs as a file format.  In general photographic-style images are best
  154. saved in JPEG format, drawings with simple blocks of colour (such as cartoons
  155. or simple diagrams) must be GIF format or you will get strange interference
  156. patterns on the final image.
  157.  
  158. File names
  159. ~~~~~~~~~~
  160. For HTML documents, you will have to adhere to some naming standards:
  161.  
  162. Under Unix, filenames are case sensitive, so "Acorn", "acorn", "ACORN" and
  163. "AcOrN" are different files. However, there is an informal convention of
  164. sticking to lower case filenames for HTML documents.
  165.  
  166. Like PCs, filenames can have full-stops (".") in them.
  167.  
  168. GIF files should end in ".gif", JPEGs in ".jpeg", and HTML files in ".html".
  169. However, WebLoad II allows you to choose which convention to use - 
  170. UNIX machines have extensions like ".html", ".jpeg" but PCs use three letters
  171. such as ".htm" and ".jpg" - you must stick to one style or the other, and
  172. make sure that WebLoad II has been set up correctly.
  173.  
  174. When referring to them inside HTML documents, use the full-stop, but when you
  175. are naming the file on your hard disc you have to be careful: Acorn's can't use
  176. full-stops in filenames, you will have to replace the "." in the filename with
  177. a "/". To demonstrate this, an image would be referenced in an HTML document as
  178. "piccy.gif". On the Acorn machine, this is stored on your hard disc as
  179. "piccy/gif".
  180.  
  181. The first page of your home page is called "index.html" (which would be stored
  182. on your hard disc as "index/html").  You MUST have a file called index.html (or
  183. index.htm, home.html or home.htm) because if you don't people will go to your
  184. web site and just find a list of files rather than being automatically given
  185. the first page of your site. 
  186.  
  187. On previous versions of WebLoad you were restricted to one directory, and
  188. because Acorn machines only allow 77 files in a directory this was a limit to
  189. the size of your site unless you used a "patch" to break the 77 file limit.
  190. However, you can now have sub-directories in your site.  We recommend a limit
  191. of nesting these no more than three deep off the main directory ("nesting"
  192. means a directory within a directory) - as this makes it theoretically possible
  193. to have over 35,000,000 directories we don't think this will be too limiting!
  194.  
  195. Filenames can be very long. If you want to simulate this, use !LongFiles or
  196. X-Files, available from our FTP PD site (go to the FTP site at 
  197. ftp.argonet.co.uk and look in the directory pub/Acorn/PD/ for the index file)
  198.  
  199. If you want to find some links, or some resources for your web site, then
  200. you could try some search engines, such as Yahoo, or Excite, and look up
  201. graphics, or something like it. Their addresses are :
  202.  
  203. http://www.yahoo.com/
  204. http://www.excite.com/
  205.  
  206. Testing the web pages
  207. ~~~~~~~~~~~~~~~~~~~~~
  208. Create a directory which you will put your web pages in. You will need an
  209. HTML file called "index/html", otherwise your page won't work. All you need
  210. to do is double-click on the HTML file. This "index.html" page is referred
  211. to as your 'home page', because it is the first page someone looking at
  212. your site will see.
  213.  
  214. All references within your directory shouldn't have any form of pathname at
  215. the beginning of the reference, as shown above. These references should be
  216. in Unix format, so that on your hard disc, a GIF file would be represented
  217. "ADFS::HardDisc4.$.WebPages.mypiccy/gif", whereas the reference stored in
  218. the HTML document will be "mypiccy.gif".
  219.  
  220. Note that all files are case sensitive, so you can't put it as "MyPiccy.GIF"
  221. which would work when testing using RISC OS.
  222.  
  223. If the filename, including the extension (e.g. ".jpeg") would be longer than 10
  224. characters, you can truncate it to 10 characters, so the file "voyager.jpeg"
  225. would be stored in your directory as "voyager/jp".  However, in your HTML code
  226. you should use the proper version, "voyager.jpeg"
  227.  
  228. Adding binaries (archives) and text files
  229. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  230. You can include binaries which can be FTP downloaded, for example, to
  231. contain some software you've written you wish to release. To create the
  232. link, use the same method for referring to other pages, ie :
  233.  
  234. To download my software, click <A HREF="my_arc.arc">here</A>.
  235.  
  236. You will need to be careful with the filenames - an ArcFS archive would
  237. have a ".arc" extension; a SparkFS archive ".zip" and a PackDir file as
  238. ".pak". If you want to put other types of files, archive them using one of
  239. these archivers instead. It'll also make your site smaller as well.
  240.  
  241. If you want to have any text files, they MUST have the extension "/txt",
  242. otherwise, they end up with the extension "/map" for image maps. Because of
  243. the 10 character limit, WebPack will use just "/t" to see if you want it as a
  244. text file, so "image/txt" and "imagine/tx" would end up as text files
  245. (assuming they were file-typed as text files), but "imaginate/" would be an
  246. image map file.
  247.  
  248. WebLoad II will expand known extensions to the following :
  249.  
  250. File type &695 (GIF) - /gif
  251. File type &faf (HTML) - /html
  252. File type &c85 (JPEG) - /jpeg
  253. File type &fff (Text) - /map (unless it has /txt after the name)
  254.  
  255. SoTIMM will convert the further types :
  256.  
  257. File type &3fb (Archive) - /arc (ArcFS)
  258. File type &ddc (Archive) - /zip (SparkFS)
  259. File type &c46 (Tar) - /tar
  260. File type &68e (PackDir) - /pak
  261. File type &fb1 (PC .WAV) - /wav
  262. File type &ae4 (JAVA) - /class
  263.  
  264. The example web pages
  265. ~~~~~~~~~~~~~~~~~~~~~
  266. If you find that this sounds really daunting, then you can look at the
  267. example web page included. This has all the elements you need for a typical
  268. home page. You are free to edit it, and to view it, simply double-click on
  269. the index/html file. If it's already in the web browser window, click on Reload.
  270.  
  271. Sending us the web pages
  272. ~~~~~~~~~~~~~~~~~~~~~~~~
  273. With this document, there is program called WebLoad. This will package
  274. up your directory containing your web pages and images. Webload is a VIX
  275. (Voyager Internet eXtension) file - if you are familiar with this type of
  276. program then simply install this and put the keycode you should have been given
  277. into the relevant space on the choices window.  If you're not familiar with
  278. this procedure, or if you need further instructions with the setting up or use
  279. of this program then go to the web page at http://www.argonet.co.uk/Webload/ 
  280.  
  281. When you have uploaded your pages, and depending on how you have configured you
  282. copy of Webload II, you can see a link to your page by going to the following
  283. web page: http://www.argonet.co.uk/users/
  284. The date and time your site was last modified, along with a short message of
  285. your choosing, will be displayed.
  286.  
  287. Please note that the files MUST be the correct file type - GIFs are filetype
  288. &695, JPEGs are &C85, and HTML pages are &FAF. !WebPack will use this to
  289. determine what extension to add, if the correct one has been truncated.
  290.  
  291. Because WebLoad II keeps track of you web site, once you have uploaded your
  292. site once, any subsequent uploads will only be the files that have changed.
  293.  
  294. You will be emailed when your site has been uploaded, telling you the date and
  295. time it was updated and the total size of your site.  It should only take about
  296. half an hour between the completion of you uploading your web pages and them
  297. appearing on you web site, but this depends on how much you are uploading and
  298. how many other people are doing the same thing.  If your pages do not appear
  299. within half a day or so it could be because the upload was corrupt, or because
  300. the automated system for processing files has stopped working - email
  301. support@argonet.co.uk in this case.
  302.  
  303. Validating the web pages
  304. ~~~~~~~~~~~~~~~~~~~~~~~~
  305. There are a number of servers available which will take your uploaded web
  306. pages, and validate them. These are generally very fussy, and will give
  307. errors for the slightest of problems.
  308.  
  309. One of these can be found at :
  310.  
  311. http://ugweb.cs.ualberta.ca/~gerald/validate/
  312.  
  313. There's an FAQ also accessible from this site regarding the vaildator.  There
  314. are also a number of programs which will do this job for you on your Acorn -
  315. look at the Support web pages and visit the software section for more
  316. information.
  317.  
  318. Finally
  319. ~~~~~~~
  320. The world wide web is a large beast, and there is a huge wealth of
  321. information available on it. If you want people to look at your page, then
  322. try to make it look pretty, or unusual. If it looks bad, conversely, you
  323. may even end up on someones "worst sites to visit" list!
  324.  
  325. If you want, you can register your page with a search engine, so that other
  326. people can access it, and you could add it to the bottom of your signature,
  327. so when you post on newsgroups, or e-mail people, others can visit it.
  328.  
  329. If you want more information about such items as web counters, forms,
  330. or stores of ready-made images, then please visit the Support web pages
  331. and look at the Web section.
  332.